package com.jprocms.module.cms.service.operate;

import com.jprocms.module.cms.controller.portal.vo.OperateCreateReqVO;
import com.jprocms.module.cms.controller.portal.vo.OperateQueryReqVO;
import com.jprocms.module.cms.dal.dataobject.operate.OperateDO;
import com.jprocms.module.cms.enums.EnumFrontOperate;
import com.jprocms.module.cms.enums.EnumFrontOperateQueryType;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.validation.Valid;
import java.time.OffsetDateTime;
import java.util.Collection;
import java.util.List;

/**
 * 操作记录 Service 接口
 *
 * @author JPROCMS
 */
public interface OperateService {

    /**
     * 创建操作记录
     *
     * @param createReqVO 创建信息
     * @return 编号
     */
    Long createOperate(@Valid OperateCreateReqVO createReqVO);

    /**
     * 删除操作记录
     *
     * @param id 编号
     */
    void deleteOperate(Long id);

    /**
     * 获得操作记录
     *
     * @param id 编号
     * @return 操作记录
     */
    OperateDO getOperate(Long id);

    /**
     * 获得操作记录列表
     *
     * @param ids 编号
     * @return 操作记录列表
     */
    List<OperateDO> getOperateList(Collection<Long> ids);

    /**
     * 获得操作记录列表
     *
     * @param exportReqVO 查询条件
     * @return 操作记录列表
     */
    List<OperateDO> getOperateList(OperateQueryReqVO exportReqVO);

    /**
     * 获得操作记录列表查询数量
     *
     * @param exportReqVO 查询条件
     * @return 操作记录列表
     */
    Long getOperateCount(OperateQueryReqVO exportReqVO);

    /**
     * 是否存在相同操作 （根据用户id或者cookie来判断是否操作过）
     *
     * @param id       数据id
     * @param operate  操作类型
     * @param request
     * @param response
     * @return
     */
    boolean existOperate(Long id, OffsetDateTime date, EnumFrontOperate operate, EnumFrontOperateQueryType enumFrontOperateQueryType, HttpServletRequest request, HttpServletResponse response);


    /**
     * 插入操作记录
     *
     * @param id      数据id
     * @param operate 操作类型
     * @param cookie  cookie
     * @param ip      ip
     * @param userId  用户id
     */
    void insertOperate(Long id, EnumFrontOperate operate, long cookie, String ip, Long userId);

}
